home *** CD-ROM | disk | FTP | other *** search
/ Aminet 31 / Aminet 31 (1999)(Schatztruhe)[!][Jun 1999].iso / Aminet / dev / debug / ggdebug.lha / AutoDocs / debug.doc
Encoding:
Text File  |  1999-03-11  |  5.2 KB  |  198 lines
  1. TABLE OF CONTENTS
  2.  
  3. debug.lib/KCmpStr
  4. debug.lib/KDoFmt
  5. debug.lib/KGetChar
  6. debug.lib/KMayGetChar
  7. debug.lib/KPutChar
  8. debug.lib/KPutStr
  9. debug.lib/VKPrintf
  10. debug.lib/KCmpStr                                           debug.lib/KCmpStr
  11.  
  12.    NAME
  13.         KCmpStr -- compare two NULL-terminated strings. (V37)
  14.  
  15.    SYNOPSIS
  16.         mismatch = KCmpStr(string1, string2)
  17.         D0                 A0       A1
  18.  
  19.         LONG KCmpStr(STRPTR, STRPTR);
  20.  
  21.    FUNCTION
  22.         string1 is compared to string2 using the ASCII collating sequence.
  23.         If the strirngs have different lengths, the shorter is treated as if
  24.         it were extended with zeros.
  25.  
  26.    INPUTS
  27.         string1, string2 - strings to be compared.
  28.  
  29.    RESULT
  30.         result - value representing relationship between string1 and string2:
  31.                      <0 means string1 < string2
  32.                      =0 means string1 = string2
  33.                      >0 means string1 > string2
  34.  
  35.    NOTES
  36.  
  37.    SEE ALSO
  38.         locale.library/StrnCmp(),
  39.         utility.library/Stricmp(), utility.library/Strnicmp().
  40.  
  41. debug.lib/KDoFmt                                             debug.lib/KDoFmt
  42.  
  43.    NAME
  44.         KDoFmt -- format data into a character stream. (V37)
  45.  
  46.    SYNOPSIS
  47.         nextData = KDoFmt(formatString, dataStream, putChProc, putChData)
  48.         D0                A0            A1          A2         A3
  49.  
  50.         APTR KDoFmt(STRPTR, STRPTR, void (*)(), APTR);
  51.  
  52.    FUNCTION
  53.         Interface to ROM RawDoFmt() function.
  54.  
  55.    INPUTS
  56.         formatString - "C"-language-like NULL terminated format string.
  57.         dataStream   - stream of data to be interpreted.
  58.         putChProc    - the procedure to call with each character to be
  59.                        output.
  60.         putChData    - the value that is passed through to the putChProc
  61.                        procedure.
  62.  
  63.    RESULT
  64.         nextData - pointer to end of the data stream (the next argument that
  65.                    would have been processed).
  66.  
  67.    NOTES
  68.  
  69.    SEE ALSO
  70.         exec.library/RawDoFmt().
  71.  
  72. debug.lib/KGetChar                                         debug.lib/KGetChar
  73.  
  74.    NAME
  75.         KGetChar -- get a character from the debugging console. (V37)
  76.  
  77.    SYNOPSIS
  78.         char = KGetChar()
  79.         D0
  80.  
  81.         LONG KGetChar(VOID);
  82.  
  83.    FUNCTION
  84.         Busy waits until a character arrives from the debugging console
  85.         (defaults to the serial port at 9600 baud).
  86.  
  87.    RESULT
  88.         char - a character that arrived from console.
  89.  
  90.    NOTES
  91.         @KGetChar, @kgetc and KGetChar are identical assembly interfaces.
  92.         _KGetChar, _kgetc are the C interfaces.
  93.  
  94. debug.lib/KMayGetChar                                   debug.lib/KMayGetChar
  95.  
  96.    NAME
  97.         KMayGetChar -- get a character from debugging console if present,
  98.                        but don't wait. (V37)
  99.  
  100.    SYNOPSIS
  101.         flagchar = KMayGetChar()
  102.         D0
  103.  
  104.         LONG KMayGetChar(VOID);
  105.  
  106.    FUNCTION
  107.         Checks the status of the debugging console (defaults to the serial
  108.         port at 9600 baud). Returns either -1, saying that there is no
  109.         character present, or whatever character was waiting.
  110.  
  111.    RESULT
  112.         char - a character that arrived from console, or -1 if there was
  113.                no char waiting.
  114.  
  115.    NOTES
  116.  
  117. debug.lib/KPutChar                                         debug.lib/KPutChar
  118.  
  119.    NAME
  120.         KPutChar -- put a character to the debugging console. (V37)
  121.  
  122.    SYNOPSIS
  123.         char = KPutChar(char)
  124.         D0              D0
  125.  
  126.         LONG KPutChar(LONG);
  127.  
  128.    FUNCTION
  129.         Puts a character to the debugging console (defaults to the serial
  130.         port at 9600 baud). This function will not return until the
  131.         character has been completely transmitted.
  132.  
  133.    INPUTS
  134.         char - a char to be outputted.
  135.  
  136.    RESULT
  137.         char - a character that was outputted.
  138.  
  139.    NOTES
  140.  
  141. debug.lib/KPutStr                                           debug.lib/KPutStr
  142.  
  143.    NAME
  144.         KPutStr -- put a string to the debugging console. (V37)
  145.  
  146.    SYNOPSIS
  147.         KPutStr(string)
  148.                 A0
  149.  
  150.         VOID KPutStr(STRPTR);
  151.  
  152.    FUNCTION
  153.         Puts a NULL-terminated string to debugging console (defaults to the
  154.         serial port at 9600 baud). This function will not return until the
  155.         string has been completely transmitted.
  156.  
  157.    INPUTS
  158.         string - a string to be outputted.
  159.  
  160.    NOTES
  161.  
  162.    SEE ALSO
  163.         KPutChar(), KPrintf().
  164.  
  165. debug.lib/VKPrintf                                         debug.lib/VKPrintf
  166.  
  167.    NAME
  168.         VKPrintf -- print formatted data to the debugging console. (V37)
  169.  
  170.    SYNOPSIS
  171.         nextData = VKPrintf(format, data)
  172.         D0                  A0      A1
  173.  
  174.         APTR VKPrintf(STRPTR, APTR);
  175.  
  176.         nextData = KPrintf(buffer, format, ...)
  177.  
  178.         APTR KPrintf(STRPTR, STRPTR, ...);
  179.  
  180.    FUNCTION
  181.         Prints data formatted with C-like string to the debugging console
  182.         (defaults to the serial port at 9600 baud). The data is formatted
  183.         using ROM RawDoFmt() function.
  184.  
  185.    INPUTS
  186.         format - "C"-language-like NULL terminated format string.
  187.         data   - stream of data to be interpreted.
  188.  
  189.    RESULT
  190.         nextData - pointer to end of the data stream (the next argument that
  191.                    would have been processed).
  192.  
  193.    NOTES
  194.  
  195.    SEE ALSO
  196.         KDoFmt(), exec.library/RawDoFmt().
  197.  
  198.